/*
 * Fichier: ExerciceModel.java
 * Crée le: 08 septembre 2007.
 * Modifié: 14 février 2009.
 * Auteurs: Sébastien ESTIENNE.
 * SiteWeb: http://www.prog-info.org/
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package javaexos.model;



import java.util.List;



/**
 * <p>Interface mutable décrivant un exercice.</p>
 * @author Sébastien ESTIENNE.
 */
public interface ExerciseModel extends Comparable<ExerciseModel>
{
   /**
    * <p>Type d'exercice.</p>
    */
   public enum ExoType
   {
      /** Type jar. */
      JAR("jar"),

      /** Type java web start. */
      JWS("jws"),

      /** Type applet. */
      APPLET("applet");

      /** Nom du type. */
      protected String label;


      /**
       * <p>Constructeur.</p>
       * @param label Le nom du type.
       */
      private ExoType(String label)
      {
         this.label = label;
      }


      /**
       * <p>Retourne le nom du type.</p>
       * @return Renvoie le nom du type.
       */
      public String getLabel()
      {
         return this.label;
      }
   }


   /**
    * <p>Renvoie le numéro de l'exercice.</p>
    * @return Retourne le numéro de l'exercice.
    */
   public int getNumber();


   /**
    * <p>Renvoie le titre de l'exercice.</p>
    * @return Retourne le titre de l'exercice.
    */
   public String getTitle();


   /**
    * <p>Renvoie le nom de l'exercice.</p>
    * @return Retourne le nom de l'exercice.
    */
   public String getName();


   /**
    * <p>Renvoie le type de l'exercice.</p>
    * @return Retourne le type de l'exercice.
    */
   public ExoType getType();


   /**
    * <p>Renvoie l'énoncé de l'exercice.</p>
    * @return Retourne l'énoncé de l'exercice.
    */
   public String getDeclaration();


   /**
    * <p>Renvoie la liste des fichiers sources de l'exercice.</p>
    * @return Retourne la liste des fichiers sources de l'exercice.
    */
   public List<String> getFiles();


   /**
    * <p>Retourne le nom complet de la classe principale.</p>
    * @return Renvoie nom complet de la classe principale.
    */
   public String getMainClass();


   /**
    * <p>Renvoie la liste des noms des images de l'exercice.</p>
    * @return Retourne la liste des noms des images de l'exercice.
    */
   public List<String> getImages();
   
   
   /**
    * <p>Renvoie la référence vers le chapitre associé à l'exercice.</p>
    * @return Retourne la référence vers le chapitre associé à l'exercice.
    */
   public ChapterModel getChapter();
}
